home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / sunrise / adopt29.zip / ADOPT.DOC < prev    next >
Text File  |  1993-01-02  |  13KB  |  308 lines
  1.  
  2.                             ADOPT - A - DOOR
  3.  
  4.                                   v2.9
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    ADOPT is a stand-alone program that can be executed after every Door program
  21.    completes and before it returns to your BBS.  It will display a message that
  22.    encourages your callers to donate to the BBS by adopting a given door or
  23.    group of doors and having his/her name displayed every time the particular
  24.    door is executed. There are 2 options available with ADOPT:
  25.  
  26.    OPTION 1, UNREGISTERED version, will display a hard-coded (non-changeable)
  27.    message describing the Adopt-A-Door concept to your callers. The REGISTERED
  28.    version will allow you to create your own message (15 lines, 62 characters
  29.    per line).
  30.  
  31.    OPTION 2 will display the names of the callers (max of 8) that have
  32.    contributed to the registration of that particular door. This file is an
  33.    ASCII file you create with the names of the callers (Max 30 char/name). The
  34.    name of the file is your choice, but the name must match with the name in
  35.    the configuration file.
  36.  
  37.  
  38.  
  39.    NOTE: Runtime errors will be logged to a file called DFRAME.ERR which is
  40.          created in the directory you run the door from.
  41.  
  42.  
  43.  
  44.                               INSTALLATION
  45.                               ____________
  46.  
  47.  
  48.    Installation is fairly easy and straight-forward. The following steps and
  49.    examples should have you up and running in a very short period of time.
  50.    It is assumed that you are familiar with setting up DOORS on your system.
  51.    To this end, only examples of the configuration file and Door batch file
  52.    are described.
  53.  
  54.       1) Create a directory to hold all ADOPT files
  55.  
  56.       2) Unzip ADOPTxx.ZIP into the the above directory
  57.  
  58.       3) Create a configuration file, with a name of your choice, or
  59.          modify the supplied ADOPT.CFG file. A description follows:
  60.  
  61.             **                       Location of system files (see below)
  62.             SUNRISE-80 BBS           Your BBS Name
  63.             Al                       Sysop's First Name
  64.             Lawrence                 Sysop's Last Name
  65.  
  66. |-----------------------------------------------------------------------------|
  67. | READ!     1                        CommPort  \ These 2 lines are required   |
  68. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  69. |-----------------------------------------------------------------------------|
  70.  
  71.             00000000                 Registration Number
  72.             1                        1=Initial Message Display
  73.                                      2=Display Callers Names That Contributed
  74.        #    201                      ASCII Character Used TO Form Message Border
  75.        #    NONE                     File Name Containing Initial Display
  76.        #    NONE                     File Name Containing Contributing Callers
  77.        #    30                       Number of SECONDS To Keep Msg On Screen
  78.        !    0                        Security level that will bypass the DOOR
  79.        !    0                        Security level that will bypass the DOOR
  80.        !    0                        Security level that will bypass the DOOR
  81.        !    0                        Security level that will bypass the DOOR
  82.        !    0                        Security level that will bypass the DOOR
  83.        !    0                        Security level that will bypass the DOOR
  84.        !    0                        Security level that will bypass the DOOR
  85.        !    0                        Security level that will bypass the DOOR
  86.        !    0                        Security level that will bypass the DOOR
  87.        !    0                        Security level that will bypass the DOOR
  88.  
  89.        ** = Replace with ONE of the following:
  90.  
  91. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  92. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  93. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  94.                                    (Note:DOOR.SYS must be in SAME directory)
  95. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  96. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  97. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  98. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  99. C:\BBS\CHAIN.TXT                <- For WWIV systems
  100. C:\BBS\GTUSER.BBS               <- For GT Power
  101.                                    * if using this option you must put the
  102.                                      ComPort # on line 5 and the Node # on
  103.                                      line 6 of the configuration file
  104.  
  105.  
  106.  
  107.         # = Requires registration to change to a different value
  108.         ! = If callers Security level matches any one of these levels,
  109.             the Adopt-A-Door program will NOT run!
  110.  
  111.  
  112.       4) Add ADOPT to the batch file that runs the Door, after whose completion
  113.          you want the ADOPT-A-DOOR message to be displayed. Using Yahtzee as
  114.          the example of the Door we want to run ADOPT after:
  115.  
  116.             ECHO off
  117.             cd\PCB\DOORS\YAHTZEE      Location of Yahtzee files
  118.             YAHTZEE YAHTZEE.CNF       EXE filename and CNF filename
  119.             CD\PCB\DOORS\ADOPT        Location of ADOPT Files
  120.             ADOPT ADOPTYAH.CFG        EXE and UNIQUE .CNF Filename created
  121.                                       in #3 above.
  122.             CD\PCB
  123.             BOARD
  124.  
  125.  
  126.        5) When running in more than one node, be sure to supply a
  127.           different configuration name for each node (your choice of name).
  128.  
  129.        6) If running with multi-port boards add /FD to the line containing
  130.           the CFG name as follows:
  131.  
  132.                         ADOPT Adopt.CFG /FD
  133.  
  134.  
  135.  
  136.                         NON-STANDARD COM SUPPORT
  137.                         ________________________
  138.  
  139.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  140.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  141.       number after the configuration filename. Let's assume your Door is
  142.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  143.       passed to your Door would be:
  144.  
  145.                             FOOBAR FOOBAR.CFG /5
  146.  
  147.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  148.       normally used with COM1. No /x parameter is needed for the standard
  149.       IRQ's.
  150.  
  151.       As an alternative, you may use an environmental variable on the command
  152.       line. To use the variable (following the example above), place a
  153.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  154.       different IRQ number for each node). The command line would now look
  155.       like this:
  156.  
  157.                           FOOBAR FOOBAR.CFG /%IRQ%
  158.  
  159.       This, in combination with the use of the environmental variables
  160.       described in the MULTI-NODE SETUP section will allow you to use one
  161.       batch file and one config file to run this door on all nodes.
  162.  
  163.  
  164.  
  165.  
  166.                            MULTI-NODE SETUP
  167.                            ________________
  168.  
  169.       All Sunrise Doors are Multi-Node capable. Each node must have the
  170.       ability to access a configuration file which will have its own system
  171.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  172.       line. There are 2 ways to accomplish this:
  173.  
  174.       (1) Create a separate configuration file for each node. The only
  175.           difference between each file would be the location of the system
  176.           file for that particular node. For example, on my system there are 2
  177.           nodes and the first line of the config files would look like this:
  178.  
  179.                         NODE1:  H:\PCB1\DOOR.SYS
  180.                         NODE2:  H:\PCB2\DOOR.SYS
  181.  
  182.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  183.  
  184.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  185.           the following PCBoard environmental variables:
  186.  
  187.                  PCBDIR    (Directory containing the System file)
  188.                  PCBDRIVE  (Drive containing the System file)
  189.  
  190.           Thus, the first line of the SINGLE configuration file, for this Door
  191.           would look like this:
  192.  
  193.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  194.  
  195.       NOTE: This option, as described, assumes that you are running PCBoard
  196.             14.5a software. The environmental variables are automatically
  197.             created by the software for each node.
  198.  
  199.             HOWEVER, if you are running other BBS software you should be able
  200.             to set the variables EXACTLY as described below, for EACH node
  201.             (more than likely in each batch file you use to bring up EACH node):
  202.  
  203.                             PCBDRIVE=C:
  204.                             ^^^^^^^^^
  205.                             PCBDIR=\NODE2
  206.                             ^^^^^^^^
  207.  
  208.             Info with a carat (^) under it, MUST be typed as is. The rest
  209.             depends on your naming conventions.
  210.  
  211.             This, in combination with the use of the optional environmental
  212.             variable described in the NON-STANDARD COM SUPPORT section, will
  213.             allow you to use one batch file and one config file to run this
  214.             door on all nodes.
  215.  
  216.  
  217.  
  218.  
  219.                             ADOPT-A-DOOR  CONCEPT
  220.                             _____________________
  221.  
  222.     Having been a Sysop for a number of years, I have had my share of problems
  223.     and frustrations getting financial support for my board's upkeep. A fellow
  224.     Sysop left a message on my board, not long ago, about a concept that was
  225.     being used by several boards around the country.
  226.  
  227.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  228.     would be the same as sending in a donation, only this way it is earmarked
  229.     for registering a particular door. In a way, the user feels he/she is
  230.     "getting something in return". As a Door author I have decided to build
  231.     this concept into each of my Door programs. The concept replaces the
  232.     usual message "tell the Sysop to register this Door" we find in most
  233.     doors.
  234.  
  235.     At the same time I have developed this stand-alone program that will carry
  236.     this concept one step forward so as to be able to use it with any of your
  237.     door programs.
  238.  
  239.  
  240.  
  241.  
  242.                               LEGALITIES
  243.                               __________
  244.  
  245.  
  246.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  247.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  248.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  249.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  250.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  251.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  252.       OR BREACH OF ANY WARRANTY.
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                              DISTRIBUTION
  259.                              ____________
  260.  
  261.    You may make this file available for downloading from your BBS or you may
  262.    upload it to any BBS of your choice, provided that you do not make any
  263.    changes to the contents of the archive (ZIP file). The archive and its
  264.    individual contents may not be used by any service that charges any money
  265.    whatsoever, without the written permission of the author.
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                              REGISTRATION
  272.                              ____________
  273.  
  274.    I am not a subscriber to the "Crippleware" concept, and this program
  275.    reflects that philosophy. This is a full-featured program, whose
  276.    functionality is not hampered in any way, whether you register it or not.
  277.    Registration and the subsequent insertion of the registration number into
  278.    your configuation file, allows for the changing of certain default values
  279.    in the configuration file.
  280.  
  281.    To register your copy of ADOPT, please fill out the registration form
  282.    (REGISTER.FRM) and mail it along with the registraiton fee to
  283.    the name and address on the form. MUST be payable in US funds!!!!
  284.  
  285.    Be sure to use the proper upper/lower case when filling in your name and
  286.    BBS name, as they MUST match the way you entered them in the configuration
  287.    file.             ^^^^
  288.  
  289.    Based upon information supplied on the registration form, I will pre-
  290.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  291.    up your registration number or you may include a self-addressed stamped
  292.    envelope and I will send registration back by return mail.
  293.  
  294.  
  295.  
  296.                                  MISC
  297.                                  ____
  298.  
  299.    The latest version of ADOPT and other fine SUNRISE DOOR programs, are
  300.    always available for download from SUNRISE-80 BBS (404-256-9525 HST 19.2),
  301.    on first call!
  302.  
  303.    Remember, should you have any problems, questions or suggestions, be sure
  304.    to drop me a message on either of the aforementioned BBS or via the DOORS
  305.    conference on PCRELAY (RIME).  NODE=Sunrise
  306.  
  307.  
  308.